# test-docs

## Постановка задачи

Нужен простой способ опубликовать в сети документацию в формате markdown.

Существующие решения для создания "статических" сайтов (например Sphinx) не подходят. По ряду причин. Например, они НЕ попадают в разряд "простых" решений.

Что я здесь подразумеваю под "простым" решением:

1. Скопировал код из репозитория на свой хостинг.
2. Добавил markdown-документацию в директорию "content".
3. Пользуешься.

Если возникает необходимость кастомизации, для этого должно хватать базовых знаний css, без необходимости погружения во внутренности фреймворка.

## Базовые принципы

1. KISS-принцип (делай проще, идиот).
2. На стороне сервера храним сырые markdown-файлы, отдаем их клиенту по запросу. Компиляция html из markdown происходит на стороне клиента, средствами javascript.
3. Используем ванильные html/css/javascript.
4. Минимально необходимое использование сторонних библиотек и ресурсов.
5. Frontend реализован по принципу single-page-app.
6. Backend отсутствует (не нужен).
7. Минималистичный дизайн. Моноширинной шрифт, отсутствие ненужных картинок.
8. Кроссбраузерность и поддержка любых устройств, которые могут запустить html/css/javascript.

## Что дальше?

[Архитектура](arch.md)